/*
 * Copyright 2011 The Rusted Roof, LLC.
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */

package org.proteusframework.core.api.model;

import java.net.URL;

/**
 * Identifies that an {@link IDisplayableName} is capable of visually depicting itself in the UI, typically for
 * higher level configuration purposes.
 */
public interface IGlyph
{

    /**
     * Path to the default icon resource used when no glyph is explicitly defined by the concrete class.
     */
    String MISSING_ICON = "/org/proteusframework/core/resources/missing.png";


    /**
     * URL that points to an image used to graphically represent an {@link IDisplayableName}.
     *
     * @return Image URL used for graphical representation
     */
    URL getGlyphURL();
}
